<!doctype html>
<html class="no-js">
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
    <title>org.jetbrains.dokka.uitest.kdoc</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">    <script>var pathToRoot = "../../";</script>
    <script>document.documentElement.classList.replace("no-js","js");</script>
    <script>const storage = localStorage.getItem("dokka-dark-mode")
    if (storage == null) {
        const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
        if (osDarkSchemePreferred === true) {
            document.getElementsByTagName("html")[0].classList.add("theme-dark")
        }
    } else {
        const savedDarkMode = JSON.parse(storage)
        if(savedDarkMode === true) {
            document.getElementsByTagName("html")[0].classList.add("theme-dark")
        }
    }
    </script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async></script>
<link href="../../styles/style.css" rel="Stylesheet">
<link href="../../styles/main.css" rel="Stylesheet">
<link href="../../styles/prism.css" rel="Stylesheet">
<link href="../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../scripts/clipboard.js" async></script>
<script type="text/javascript" src="../../scripts/navigation-loader.js" async></script>
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async></script>
<script type="text/javascript" src="../../scripts/main.js" defer></script>
<script type="text/javascript" src="../../scripts/prism.js" async></script>
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer></script>
<link href="../../styles/multimodule.css" rel="Stylesheet"></head>
<body>
    <div class="root">
<nav class="navigation" id="navigation-wrapper">
    <div class="navigation--inner">
        <div class="navigation-title">
            <button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
            <div class="library-name">
<a class="library-name--link" href="../../index.html">
                            ui-showcase
                    </a>            </div>
            <div class="library-version">
<dokka-template-command data="{&quot;@class&quot;:&quot;org.jetbrains.dokka.base.templating.ReplaceVersionsCommand&quot;,&quot;location&quot;:&quot;org.jetbrains.dokka.uitest.kdoc/index.html&quot;}">0.9</dokka-template-command>            </div>
        </div>
        <div class="filter-section" id="filter-section">
                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":jvm:dokkaHtmlPartial/main">jvm</button>
        </div>
    </div>
    <div class="navigation-controls">
        <button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
        <div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
    </div>
</nav>
        <div id="container">
            <div class="sidebar" id="leftColumn">
                <div class="sidebar--inner" id="sideMenu"></div>
            </div>
            <div id="main">
<div class="main-content" data-page-type="package" id="content" pageids="jvm::org.jetbrains.dokka.uitest.kdoc////PointingToDeclaration//-1323072359">
  <div class="breadcrumbs"><a href="../index.html">jvm</a><span class="delimiter">/</span><span class="current">org.jetbrains.dokka.uitest.kdoc</span></div>
  <div class="cover ">
    <h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
    <div class="platform-hinted UnderCoverText" data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":jvm:dokkaHtmlPartial/main"><p class="paragraph">Displays various KDoc tags and whatnot</p></div></div>
  </div>
  <div class="tabbedcontent">
    <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="TYPE">Types</button><button class="section-tab" data-togglable="FUNCTION,EXTENSION_FUNCTION">Functions</button></div>
    <div class="tabs-section-body">
      <div data-togglable="TYPE">
        <h2 class="">Types</h2>
        <div class="table"><a data-name="1529137295%2FClasslikes%2F-1323072359" anchor-label="ClassKDocs" id="1529137295%2FClasslikes%2F-1323072359" data-filterable-set=":jvm:dokkaHtmlPartial/main"></a>
          <div class="table-row" data-filterable-current=":jvm:dokkaHtmlPartial/main" data-filterable-set=":jvm:dokkaHtmlPartial/main">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="-class-k-docs/index.html"><span>Class</span><wbr><span><span>KDocs</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1529137295%2FClasslikes%2F-1323072359"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":jvm:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">class </span><a href="-class-k-docs/index.html">ClassKDocs</a><span class="token operator">&lt;</span><a href="-class-k-docs/index.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>primaryConstructorProperty<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">A demonstration of various KDoc tags</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
        </div>
      </div>
      <div data-togglable="FUNCTION">
        <h2 class="">Functions</h2>
        <div class="table"><a data-name="-184487187%2FFunctions%2F-1323072359" anchor-label="additionalInfo" id="-184487187%2FFunctions%2F-1323072359" data-filterable-set=":jvm:dokkaHtmlPartial/main"></a>
          <div class="table-row" data-filterable-current=":jvm:dokkaHtmlPartial/main" data-filterable-set=":jvm:dokkaHtmlPartial/main">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="additional-info.html"><span>additional</span><wbr><span><span>Info</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-184487187%2FFunctions%2F-1323072359"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":jvm:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="additional-info.html"><span class="token function">additionalInfo</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">This documentation contains additional info</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="1361597072%2FFunctions%2F-1323072359" anchor-label="allKDocTagsInOnePlace" id="1361597072%2FFunctions%2F-1323072359" data-filterable-set=":jvm:dokkaHtmlPartial/main"></a>
          <div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":jvm:dokkaHtmlPartial/main" data-filterable-set=":jvm:dokkaHtmlPartial/main">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="all-k-doc-tags-in-one-place.html"><span>all</span><wbr><span>KDoc</span><wbr><span>Tags</span><wbr><span>In</span><wbr><span>One</span><wbr><span><span>Place</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1361597072%2FFunctions%2F-1323072359"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":jvm:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="../org.jetbrains.dokka.uitest.types/-simple-kotlin-class/index.html">SimpleKotlinClass</a><span class="token punctuation">.</span><a href="all-k-doc-tags-in-one-place.html"><span class="token function">allKDocTagsInOnePlace</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">i<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter ">s<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">This demonstrates all KDoc tags in one place</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="-1264022085%2FFunctions%2F-1323072359" anchor-label="extension" id="-1264022085%2FFunctions%2F-1323072359" data-filterable-set=":jvm:dokkaHtmlPartial/main"></a>
          <div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":jvm:dokkaHtmlPartial/main" data-filterable-set=":jvm:dokkaHtmlPartial/main">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="extension.html"><span><span>extension</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1264022085%2FFunctions%2F-1323072359"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":jvm:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="../org.jetbrains.dokka.uitest.types/-simple-kotlin-class/index.html">SimpleKotlinClass</a><span class="token punctuation">.</span><a href="extension.html"><span class="token function">extension</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Describes an extension function</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="-1778870830%2FFunctions%2F-1323072359" anchor-label="functionWithAReallyLongNameSimilarToThatClassWithALongNameButThisOneIsAFunction" id="-1778870830%2FFunctions%2F-1323072359" data-filterable-set=":jvm:dokkaHtmlPartial/main"></a>
          <div class="table-row" data-filterable-current=":jvm:dokkaHtmlPartial/main" data-filterable-set=":jvm:dokkaHtmlPartial/main">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="function-with-a-really-long-name-similar-to-that-class-with-a-long-name-but-this-one-is-a-function.html"><span>function</span><wbr><span>With</span><wbr><span>AReally</span><wbr><span>Long</span><wbr><span>Name</span><wbr><span>Similar</span><wbr><span>To</span><wbr><span>That</span><wbr><span>Class</span><wbr><span>With</span><wbr><span>ALong</span><wbr><span>Name</span><wbr><span>But</span><wbr><span>This</span><wbr><span>One</span><wbr><span>Is</span><wbr><span><span>AFunction</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1778870830%2FFunctions%2F-1323072359"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":jvm:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="function-with-a-really-long-name-similar-to-that-class-with-a-long-name-but-this-one-is-a-function.html"><span class="token function">functionWithAReallyLongNameSimilarToThatClassWithALongNameButThisOneIsAFunction</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="39470463%2FFunctions%2F-1323072359" anchor-label="links" id="39470463%2FFunctions%2F-1323072359" data-filterable-set=":jvm:dokkaHtmlPartial/main"></a>
          <div class="table-row" data-filterable-current=":jvm:dokkaHtmlPartial/main" data-filterable-set=":jvm:dokkaHtmlPartial/main">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="links.html"><span><span>links</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="39470463%2FFunctions%2F-1323072359"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":jvm:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="links.html"><span class="token function">links</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">This documentation links to <a href="../org.jetbrains.dokka.uitest.types/-simple-kotlin-class/index.html">SimpleKotlinClass</a> and SimpleJvmClass and <a href="https://kotl.in/dokka">website</a> and even this</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="-349789341%2FFunctions%2F-1323072359" anchor-label="multipleLinkSections" id="-349789341%2FFunctions%2F-1323072359" data-filterable-set=":jvm:dokkaHtmlPartial/main"></a>
          <div class="table-row" data-filterable-current=":jvm:dokkaHtmlPartial/main" data-filterable-set=":jvm:dokkaHtmlPartial/main">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="multiple-link-sections.html"><span>multiple</span><wbr><span>Link</span><wbr><span><span>Sections</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-349789341%2FFunctions%2F-1323072359"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":jvm:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="multiple-link-sections.html"><span class="token function">multipleLinkSections</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">s<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">i<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="93726618%2FFunctions%2F-1323072359" anchor-label="params" id="93726618%2FFunctions%2F-1323072359" data-filterable-set=":jvm:dokkaHtmlPartial/main"></a>
          <div class="table-row" data-filterable-current=":jvm:dokkaHtmlPartial/main" data-filterable-set=":jvm:dokkaHtmlPartial/main">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="params.html"><span><span>params</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="93726618%2FFunctions%2F-1323072359"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":jvm:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="params.html"><span class="token function">params</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">foo<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Describes a function with a parameter</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="-1700062699%2FFunctions%2F-1323072359" anchor-label="throws" id="-1700062699%2FFunctions%2F-1323072359" data-filterable-set=":jvm:dokkaHtmlPartial/main"></a>
          <div class="table-row" data-filterable-current=":jvm:dokkaHtmlPartial/main" data-filterable-set=":jvm:dokkaHtmlPartial/main">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="throws.html"><span><span>throws</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1700062699%2FFunctions%2F-1323072359"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":jvm:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="throws.html"><span class="token function">throws</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">This functions throws.</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
<a data-name="258478386%2FFunctions%2F-1323072359" anchor-label="withSample" id="258478386%2FFunctions%2F-1323072359" data-filterable-set=":jvm:dokkaHtmlPartial/main"></a>
          <div class="table-row" data-filterable-current=":jvm:dokkaHtmlPartial/main" data-filterable-set=":jvm:dokkaHtmlPartial/main">
            <div class="main-subrow keyValue ">
              <div class=""><span class="inline-flex">
                  <div><a href="with-sample.html"><span>with</span><wbr><span><span>Sample</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="258478386%2FFunctions%2F-1323072359"></span>
                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                  </span></span></div>
              <div>
                <div class="title">
                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":jvm:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">fun </span><a href="with-sample.html"><span class="token function">withSample</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">This function contains a (runnable?) sample.</p></div></div></div>
                </div>
              </div>
            </div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>
    <div class="footer">
        <a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
        <span>© 2025 Copyright</span>
        <span class="pull-right">
            <span>Generated by </span>
            <a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
                <span>dokka</span>
            </a>
        </span>
    </div>
            </div>
        </div>
    </div>
</body>
</html>

